/**
 * @(#)${NAME}.java Aug 27, 2006
 *
 * Copyright (c) 2005-2010 Psiqueware S.A. de C.V. All Rights Reserved.
 * This software is the proprietary information Psiqueware S.A. de C.V.
 * Use is subject to license terms.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * <br/>Usuario : AngelElectrico
 * <br/>Creaci&oacute;n: Aug 27, 2006 - 2:13:39 PM
 * <br/>
 * <br/>
 * <br/><t5>Cambios :</t5>
 * <br/><b>Fecha | Autor  |  Cambios</b>
 * <br/>Aug 27, 2006 | <a href = "mailto:AngelElectrico@PsiqueWare.com">Angel El&eacute;ctrico</a> | Creaci&oacute;n del Objeto.
 */

package com.psiqueware.alheli.id.dao;

import com.psiqueware.alheli.dao.BaseDAO;
import com.psiqueware.alheli.dao.DAOException;
import com.psiqueware.alheli.dao.EnlaceTransaccional;
import com.psiqueware.alheli.id.Identificacion;
import com.psiqueware.alheli.id.Usuario;

import java.util.List;

/**
 * Contrato de operaciones CRUD para el objeto Identificacion
 * <br/>Paquete Original: com.psiqueware.basico.id.dao
 * <br/>Nombre  Original: IdentificacionDAO
 * <br/><a href="IdentificacionDAO.java.html"><i>Ver C&oacute;digo Fuente</i> </a>
 *
 * @author <a href="mailto:AngelElectrico@PsiqueWare.com">Angel El&eacute;ctrico</a>
 * @version Revision: 1.1 Aug 27, 2006 2:13:39 PM
 */
public interface IdentificacionDAO extends BaseDAO
{

    /**
     * Guarda un {@link Identificacion} en persistencia.
     * Este {@link Identificacion} no exist&iacute;a previamente en persistencia.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     * @param o                   Identificacion
     *
     * @return Login despu&eacute;s de persistirse.
     *
     * @throws com.psiqueware.alheli.dao.AlreadyPersistedObjectException
     *          en caso de que este {@link Identificacion} ya existiera en persistencia.
     */
    Identificacion saveLogin(Identificacion o, final EnlaceTransaccional enlaceTransaccional) throws DAOException;


    /**
     * Actualiza un {@link Identificacion} en persistencia
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     * @param o                   a actualizar
     *
     * @return {@link Identificacion} actualizado
     *
     * @throws com.psiqueware.alheli.dao.NotAPersistedObjectException
     *          en caso de que este {@link Identificacion} no existiera en persistencia.
     */
    Identificacion updateLogin(Identificacion o, final EnlaceTransaccional enlaceTransaccional) throws DAOException;

    /**
     * Devuelve un {@link Identificacion} a partir de su id.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     * @param id                  del {@link Identificacion} que se busca
     *
     * @return {@link Identificacion} en caso de encontrarlo, <code>null</code> en otro caso.
     *
     * @throws com.psiqueware.alheli.dao.DAOException
     *          si se presenta alg&uacute;n problema.
     */
    Identificacion findLoginPorId(Long id, final EnlaceTransaccional enlaceTransaccional) throws DAOException;


    /**
     * Devuelve un nombre de {@link Identificacion} a partir de su identificacion y autentificacion.
     *
     * @param idDominio           id del {@link Dominio} al  cual pertenece el {@link Usuario} due&ntilde;o del {@link Identificacion}.
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     * @param identificacion      del {@link Identificacion} que se busca
     * @param autentificacion     del {@link Identificacion} que se busca
     *
     * @return {@link Identificacion} en caso de encontrarlo, <code>null</code> en otro caso.
     *
     * @throws com.psiqueware.alheli.dao.DAOException
     *          si se presenta alg&uacute;n problema.
     * @noinspection FeatureEnvy
     */
    Identificacion findLoginPorIdentificacion(String identificacion, char[] autentificacion, final Long idDominio, final EnlaceTransaccional enlaceTransaccional) throws DAOException;

    /**
     * Devuelve un nombre de Usuario a partir de su identificacion.
     *
     * @param idDominio           id del {@link Dominio} al cual pertenece el {@link Usuario} para el cual se tiene el {@link Identificacion}.
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     * @param identificacion      del {@link Identificacion} que se busca
     *
     * @return {@link Identificacion} en caso de encontrarlo, <code>null</code> en otro caso.
     *
     * @throws com.psiqueware.alheli.dao.DAOException
     *          si se presenta alg&uacute;n problema.
     * @noinspection FeatureEnvy
     */
    Identificacion findLoginPorIdentificacion(final String identificacion, final Long idDominio, final EnlaceTransaccional enlaceTransaccional) throws DAOException;


    /**
     * Elimina un {@link Identificacion} del sistema de persistencia.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     * @param o                   que se pretende elimninar.
     *
     * @throws com.psiqueware.alheli.dao.NotAPersistedObjectException
     *          si dicho objeto no exist&iacute;a en persistencia.
     */
    void deleteLogin(Identificacion o, final EnlaceTransaccional enlaceTransaccional) throws DAOException;

    /**
     * Elimina el {@link Identificacion} asociado a una identificaci&oacute;n.
     *
     * @param idDominio           id del {@link Dominio} al  cual pertenece el {@link Usuario} due&ntilde;o del {@link Identificacion}.
     * @param identificacion      cuyo {@link Identificacion} se va a eliminar.
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @throws com.psiqueware.alheli.dao.DAOException
     *          si se presenta alg&uacute;n problema.
     */
    void deleteLoginPorIdentificacion(final String identificacion, final Long idDominio, final EnlaceTransaccional enlaceTransaccional) throws DAOException;

    /**
     * Devuelve un listado de los {@link Identificacion} que se encuentran en persistencia.
     *
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return List de objetos {@link Identificacion}, sin objetos en caso de no haberlos.
     *
     * @throws com.psiqueware.alheli.dao.DAOException
     *          si se presenta alg&uacute;n problema.
     */
    List<Identificacion> listLogin(EnlaceTransaccional enlaceTransaccional) throws DAOException;


    /**
     * Devuelve un listado de los {@link Identificacion} para un {@link Usuario} dado que se encuentran en persistencia.
     *
     * @param usuario             cuyos {@link Identificacion}s se buscan.
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return List de objetos {@link Identificacion}, sin objetos en caso de no haberlos.
     *
     * @throws com.psiqueware.alheli.dao.DAOException
     *          si se presenta alg&uacute;n problema.
     */
    List<Identificacion> findLoginsPorUsuario(final Usuario usuario, final EnlaceTransaccional enlaceTransaccional) throws DAOException;

    /**
     * Dice si una autenticaci&oacute;n corresponde a un {@link Identificacion} dado.
     *
     * @param identificacion      cuya autenticacion estamos verificando.
     * @param autenticacion       a verificar.
     * @param enlaceTransaccional enlace para hacer at&oacute;micas las transacciones.
     *
     * @return <code>true</code> si corresponde; <code>false</code> en caso contrario.
     *
     * @throws com.psiqueware.alheli.dao.DAOException
     *          si se presenta alg&uacute;n problema.
     */
    boolean isAutenticacion(final Identificacion identificacion, final char[] autenticacion, final EnlaceTransaccional enlaceTransaccional) throws DAOException;

}
